Interface PopupMenu

All Superinterfaces:
IPCObject
All Known Implementing Classes:
PopupMenuImpl

public interface PopupMenu extends IPCObject
Information provided by the PKI file:

    \class PopupMenu
    
    \brief PopupMenu is the popup menu instantiated from the PopupMenuBar object.
    
    \remark The built-in menus Activity Wizard, Multiuser, IPC, and the
    seperator can only be manipulated by name. These menus will not provide
    a UUID or PopupMenuItem class representation. Only items added via the IPC
    have a UUID and are a derivative of the PopupMenuItem class.
    
    \example appWindow().getPopupMenuBar().getFilePopupPopupMenu()
    
Author:
Auto-generated
  • Method Details

    • count

      int count()
      Information provided by the PKI file:
      
          \brief Returns the number of menu items in this menu.
          
          \return int, the number of menu items in this menu.
          
              
      Returns:
      int Returns a int
    • getPopupMenuItemAt

      PopupMenuItem getPopupMenuItemAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the menu item at the specified index.
          
          \param index, the index of the menu item of interest.
          
          \return PopupMenuItem, the PopupMenuItem object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      PopupMenuItem Returns a PopupMenuItem
    • getPopupMenuItemByUuid

      PopupMenuItem getPopupMenuItemByUuid(UUID id)
      Information provided by the PKI file:
      
          \brief Returns the menu item with the specified UUID.
          
          \param id, the UUID of the menu item of interest.
          
          \return PopupMenuItem, the PopupMenuItem object with the specified UUID.
          
              
      Parameters:
      id - Takes in a parameter of id
      Returns:
      PopupMenuItem Returns a PopupMenuItem
    • getPopupMenuItemByName

      PopupMenuItem getPopupMenuItemByName(String name)
      Information provided by the PKI file:
      
          \brief Returns the menu item with the specified name.
          
          \param name, the name of the menu item of interest.
          
          \return PopupMenuItem, the PopupMenuItem object with the specified name.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      PopupMenuItem Returns a PopupMenuItem
    • getPopupMenuItemUuid

      UUID getPopupMenuItemUuid(String name)
      Information provided by the PKI file:
      
          \brief Returns the UUID of the menu item with the specified name.
          
          \param name, the name of the menu item of interest.
          
          \return uuid, the UUID of the menu item with the specified name.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      UUID Returns a UUID
    • setItemVisibleUuid

      void setItemVisibleUuid(UUID id, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Changes the visibility of the item with the specified UUID.
          
          \param id, the UUID of the menu item of interest.
          \param bVisibile, true to show the menu item, false to hide it.
          
              
      Parameters:
      id - Takes in a parameter of id
      bVisible - Takes in a parameter of bVisible
    • setItemEnabledUuid

      void setItemEnabledUuid(UUID id, boolean bEnabled)
      Information provided by the PKI file:
      
          \brief Enables or disables input events to the menu item with the specified UUID.
          
          \param id, the UUID of the menu item of interest.
          \param bEnabled, true to enable input events to the menu item, false to disable it.
          
              
      Parameters:
      id - Takes in a parameter of id
      bEnabled - Takes in a parameter of bEnabled
    • removeItemUuid

      void removeItemUuid(UUID id)
      Information provided by the PKI file:
      
          \brief Removes the menu item with the specified UUID.
          
          \param id, the UUID of the menu item of interest.
          
              
      Parameters:
      id - Takes in a parameter of id
    • insertItem

      UUID insertItem(String before, String action)
      Information provided by the PKI file:
      
          \brief Inserts an item before the specified item with the specified action.
          
          \param before, the name of the menu item to insert before.
          \param action, the action of the menu item.
          
          \return uuid, the UUID of the menu item that was inserted.
          
              
      Parameters:
      before - Takes in a parameter of before
      action - Takes in a parameter of action
      Returns:
      UUID Returns a UUID
    • insertItemAfter

      UUID insertItemAfter(String after, String action)
      Information provided by the PKI file:
      
          \brief Inserts an item after the specified item with the specified action.
          
          \param after, the name of the menu item to insert after.
          \param action, the action of the menu item.
          
          \return uuid, the UUID of the menu item that was inserted.
          
              
      Parameters:
      after - Takes in a parameter of after
      action - Takes in a parameter of action
      Returns:
      UUID Returns a UUID
    • insertSeparator

      UUID insertSeparator(String before, String name)
      Information provided by the PKI file:
      
          \brief Inserts a separator before the specified item with the specified name.
          
          \param before, the name of the menu item to insert before.
          \param name, the name of the separator; not displayed but can be used to find it later.
          
          \return uuid, the UUID of the menu item that was inserted.
          
              
      Parameters:
      before - Takes in a parameter of before
      name - Takes in a parameter of name
      Returns:
      UUID Returns a UUID
    • insertSeparatorAfter

      UUID insertSeparatorAfter(String after, String name)
      Information provided by the PKI file:
      
          \brief Inserts a separator after the specified item with the specified name.
          
          \param after, the name of the menu item to insert after.
          \param name, the name of the separator; not displayed but can be used to find it later.
          
          \return uuid, the UUID of the menu item that was inserted.
          
              
      Parameters:
      after - Takes in a parameter of after
      name - Takes in a parameter of name
      Returns:
      UUID Returns a UUID
    • removeItem

      void removeItem(String name)
      Information provided by the PKI file:
      
          \brief Removes the specified menu item.
          
          \param name, the name of the menu item.
          
              
      Parameters:
      name - Takes in a parameter of name
    • setItemVisible

      void setItemVisible(String name, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides the specified menu item.
          
          \param name, the name of the menu item.
          \param bVisible, true to show the menu item, false to hide it.
          
              
      Parameters:
      name - Takes in a parameter of name
      bVisible - Takes in a parameter of bVisible
    • setItemEnabled

      void setItemEnabled(String name, boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified menu item.
          
          \param name, the name of the menu item.
          \param bEnable, true to enable the menu item, false to disable it.
          
              
      Parameters:
      name - Takes in a parameter of name
      bEnable - Takes in a parameter of bEnable
    • setItemObjectEnabled

      void setItemObjectEnabled(String name, boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified menu item using object name.
          
          \param name, the name of the menu item.
          \param bEnable, true to enable the menu item, false to disable it.
          
              
      Parameters:
      name - Takes in a parameter of name
      bEnable - Takes in a parameter of bEnable
    • insertItemWithName

      UUID insertItemWithName(String before, String action, String name)
      Information provided by the PKI file:
      
          \brief Inserts an item before the specified item with the specified action.
          
          \param before, the name of the menu item to insert before.
          \param action, the action of the menu item.
          \param name, object name assigned to the action
          
          \return uuid, the UUID of the menu item that was inserted.
          
              
      Parameters:
      before - Takes in a parameter of before
      action - Takes in a parameter of action
      name - Takes in a parameter of name
      Returns:
      UUID Returns a UUID
    • insertItemWithNameAfter

      UUID insertItemWithNameAfter(String after, String action, String name)
      Information provided by the PKI file:
      
          \brief Inserts an item after the specified item with the specified action.
          
          \param after, the name of the menu item to insert after.
          \param action, the action of the menu item.
          \param name, object name assigned to the action
          
          \return uuid, the UUID of the menu item that was inserted.
          
              
      Parameters:
      after - Takes in a parameter of after
      action - Takes in a parameter of action
      name - Takes in a parameter of name
      Returns:
      UUID Returns a UUID